Feature/docs benchmarks example #33
Open
+583
−69
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All changes were applied while benchmarking, to make sure there were no regressions made during changes.
Additions:
examples for wfc
adds two examples for WFC algorithm. In addition, theAsRef<WaveCell>
impl forWaveCellRef
, to allow applying thestep-by-step
collapse example in more readible way.benchmarks
- addition of benchmarks, both forwfc-image
andwfc
(base)additional documentation
- addition of some documentation for the most important members, as well as a brief overview inwfc/lib.rs
with pointers on how to implement the algorithm in external crates. There are still possibilities for better docs, but these pointers alone make the implementation easier, so at least partially fixes Better documentation of public members #32clippy suggestions
- clippy pointed to some things, I've fixed that.It should be possible to apply every commit independently, so feel free to cherry-pick.